home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 426-450 / disk_432 / reader / reader.doc < prev    next >
Text File  |  1992-05-06  |  7KB  |  163 lines
  1.  
  2.                           READER  V 1.0
  3.                           =============
  4.  
  5.     A program which will list any words that can be made from the letters
  6.     entered. The user can select a specific word length and can enter
  7.     'unknown' letters. Great for word games and crosswords.
  8.  
  9.     This is my first attempt at 'C' programming so please be patient!
  10.  
  11. ---------------------------------------------------------------------------
  12.  
  13.     USAGE:     Reader [-m] [-#] [-z] letters
  14.  
  15.     where -m is an instruction to match a letter pattern.         (MATCH)
  16.     where -# is the letter length. -4 to -9 for words of 4 to 9 letters.
  17.                                    -l for words of 10 or more letters.
  18.     where -z is an instruction to clear the contents of VALID.     (ZAP)
  19.  
  20.     where  letters  is the string of letters to select words from.
  21.  
  22.     The [] switches are optional and can be in any order but the letters
  23.     string MUST come last.
  24.  
  25.     The letters string should contain only alphabetic characters except
  26.     for a special facility called SPARES. Spares represent ANY letter
  27.     and should be entered as fullstops (periods).
  28.  
  29.     So, entering   ' erta. ' would find words like GREAT, HEAT and STAR
  30.     as the . character will count as a G or H or S (or anything).
  31.  
  32.     The program outputs words found to the screen and also writes to
  33.     the file VLD:VALID. This file has the same information as the screen
  34.     output but has extended statistical information listing totals by
  35.     word length and initial letter and percentages of those against the
  36.     total words found. This file can be printed or stored or erased as
  37.     desired. The results of a scan will be added to the file VALID unless
  38.     the -z (zap) switch is used. This file requires an assign. Ram is the
  39.     easiest place but users with 512k might prefer to write to disk.
  40.  
  41.  
  42.     The program can only be run from the CLI.
  43.  
  44.  
  45.     Setup
  46.     =====
  47.  
  48.     The program MUST have a data file to scan and it will look for
  49.     RAM:WORDALL.DAT or WORDLIST:WORDALL.DAT  If neither file can be
  50.     found, the program will complain and exit.
  51.  
  52.     A file, ASSIGNS, is included. Simply execute it to set WORDLIST: to
  53.     this directory and VLD: to RAM: This is the preferred option. If you
  54.     have 1 meg+, copy WORDALL.DAT to RAM: as this will greatly speed
  55.     the program and vastly reduce disk access. This should be run before
  56.     using the program. For normal use, make the assigns part of your
  57.     startup-sequence.
  58.  
  59.  
  60.     Limitations
  61.     ===========
  62.  
  63.     The letters list must not exceed 20 characters. Entering less than
  64.     4 letters will yield no words. (all words are 4+ letters) Entering
  65.     a lot of spares will yield MANY words. Beware of creating a large
  66.     VALID list; memory you know!
  67.  
  68.  
  69.     Matching
  70.     ========
  71.  
  72.     If you specify -m on the command line, you can match a string of
  73.     letters against the word list. Entering  '-m ING ' will list ALL
  74.     then words containing the letters ING (there will be lots!) or you
  75.     could limit that by '-m -7 ING ' listing only 7 letter words
  76.     containing ING. You can specify something like ' I.G ' where any word
  77.     having an I then any letter then a G would be listed. When matching,
  78.     a fullstop (period) represents ANY character (but just one per .).
  79.  
  80.     Examples
  81.     ========
  82.  
  83.     Reader hearsfec              Will find all words using HEARSFEC
  84.     Reader -4 hearsfec           Report only 4 letter words
  85.     Reader trag..                Words made from TRAG plus any two other
  86.                                    letters (like RAGE, BEAR, SPAT...)
  87.     Reader -m ing                Words containing ING
  88.     Reader -6 -m ing             Only 6 letter words containing ING
  89.     Reader -m -7 ed.             7 letter words containing ED with at least
  90.                                     one letter after the ED
  91.     Reader -m -8 .r.v.o..        Ideal search for a crossword answer. Look
  92.                                     for an 8 letter word with . representing
  93.                                     missing letters.
  94.     Reader -l -m ness            Find all long words (10+ letters)
  95.                                     containing NESS
  96.     Reader -7 -m acc....         7 letter words starting with ACC
  97.  
  98.  
  99.     Word List
  100.     =========
  101.  
  102.     The word lists are ENGLISH word spellings excluding proper names
  103.     (ie real names) but including some place names. American users will
  104.     have to put up with COLOUR instead of COLOR unless they edit the
  105.     word lists themselves. In order to reduce words, all plurals
  106.     made by simply adding S are excluded. Plurals like Cacti should be
  107.     available. The word list is simply a LARGE file containing the words
  108.     in ascii format, one word per line. It can be edited with any normal
  109.     editor. There are currently around 24,200 words in the list!
  110.  
  111.     The end user can of course supply their own word lists!
  112.  
  113.     WARNING! There may well be misspelt words in the data list, Sorry!
  114.     If you feel inclined, please send me a list of misspelt or missing
  115.     words, on paper please, don't send disks!
  116.  
  117.  
  118.     Aborting
  119.     ========
  120.  
  121.     A scan may be aborted by 'CONTROL C' which will put up a little
  122.     requester (Continue/Abort). Aborting the scan will mess up the
  123.     output of the VALID file but should cause no other problems.
  124.  
  125.  
  126.     Source
  127.     ======
  128.  
  129.     Source is supplied so you can play with it as you wish. This code is
  130.     copyrighted. It may not be used in any product sold for profit unless
  131.     you obtain my permission. Please do not sell it or claim it as your
  132.     own. It is freely distributable provided all the files are kept
  133.     together. The source was compiled under Lattice V4.0. As this is my
  134.     first attempt at 'C' the code is probably pretty primitive, but it
  135.     works...and that's what counts!
  136.  
  137.     Fred Fish is hereby granted the right to distribute these files.
  138.     No commercial organisation other than Fred Fish may distribute any
  139.     of these files for profit without the written permission of myself.
  140.     The files may be distributed by anyone provided no profit is made.
  141.  
  142.     Thanks to Fred Fish for the service he and countless others have
  143.     provided to make available the masses of excellent AMIGA software.
  144.     This program is just a small repayment for all that work.
  145.  
  146.  
  147.     Finally..
  148.     =========
  149.  
  150.     Please report any bugs, ideas, word omissions, comments to me.
  151.  
  152.     Author..
  153.  
  154.     Gary Brittain
  155.     45, Waddington Avenue
  156.     Great Barr
  157.     Birmingham
  158.     B43 5JF
  159.     England
  160.  
  161.     Email to "Brittaing@uk.ac.aston.vax.kirk"   (Bitnet?)
  162.  
  163.     © 3iff  6/91  All rights reserved.